<!DOCTYPE HTML>

<html lang="en">
<head>

<title>RelyingPartyRegistration.Builder (spring-security-docs 5.6.3 API)</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="stylesheet" type="text/css" href="../../../../../../../stylesheet.css" title="Style">
<link rel="stylesheet" type="text/css" href="../../../../../../../jquery/jquery-ui.css" title="Style">
<script type="text/javascript" src="../../../../../../../script.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip/dist/jszip.min.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils.min.js"></script>
<!--[if IE]>
<script type="text/javascript" src="../../../../../../../jquery/jszip-utils/dist/jszip-utils-ie.min.js"></script>
<![endif]-->
<script type="text/javascript" src="../../../../../../../jquery/jquery-3.5.1.js"></script>
<script type="text/javascript" src="../../../../../../../jquery/jquery-ui.js"></script>
</head>
<body>
<script type="text/javascript"><!--
    try {
        if (location.href.indexOf('is-external=true') == -1) {
            parent.document.title="RelyingPartyRegistration.Builder (spring-security-docs 5.6.3 API)";
        }
    }
    catch(err) {
    }
//-->
var data = {"i0":10,"i1":10,"i2":10,"i3":42,"i4":10,"i5":42,"i6":10,"i7":10,"i8":42,"i9":42,"i10":42,"i11":10,"i12":42,"i13":10,"i14":10,"i15":10,"i16":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete Methods"],32:["t6","Deprecated Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
var pathtoroot = "../../../../../../../";
var useModuleDirectories = true;
loadScripts(document, 'script');</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<header role="banner">
<nav role="navigation">
<div class="fixedNav">

<div class="topNav"><a id="navbar.top">

</a>
<div class="skipNav"><a href="RelyingPartyRegistration.Builder.html#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.top.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<ul class="navListSearch">
<li><label for="search">SEARCH:</label>
<input type="text" id="search" value="search" disabled="disabled">
<input type="reset" id="reset" value="reset" disabled="disabled">
</li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="RelyingPartyRegistration.Builder.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="RelyingPartyRegistration.Builder.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.top">

</a></div>

</div>
<div class="navPadding">&nbsp;</div>
<script type="text/javascript"><!--
$('.navPadding').css('padding-top', $('.fixedNav').css("height"));
//-->
</script>
</nav>
</header>

<main role="main">
<div class="header">
<div class="subTitle"><span class="packageLabelInType">Package</span>&nbsp;<a href="package-summary.html">org.springframework.security.saml2.provider.service.registration</a></div>
<h2 title="Class RelyingPartyRegistration.Builder" class="title">Class RelyingPartyRegistration.Builder</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.Builder</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>Enclosing class:</dt>
<dd><a href="RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a></dd>
</dl>
<hr>
<pre>public static final class <span class="typeNameLabel">RelyingPartyRegistration.Builder</span>
extends java.lang.Object</pre>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.summary">

</a>
<h3>Method Summary</h3>
<table class="memberSummary">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t6" class="tableTab"><span><a href="javascript:show(32);">Deprecated Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colSecond" scope="col">Method</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#assertingPartyDetails(java.util.function.Consumer)">assertingPartyDetails</a></span>&#8203;(java.util.function.Consumer&lt;<a href="RelyingPartyRegistration.AssertingPartyDetails.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.AssertingPartyDetails.Builder</a>&gt;&nbsp;assertingPartyDetails)</code></th>
<td class="colLast">
<div class="block">Apply this <code>Consumer</code> to further configure the Asserting Party details</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#assertionConsumerServiceBinding(org.springframework.security.saml2.provider.service.registration.Saml2MessageBinding)">assertionConsumerServiceBinding</a></span>&#8203;(<a href="Saml2MessageBinding.html" title="enum in org.springframework.security.saml2.provider.service.registration">Saml2MessageBinding</a>&nbsp;assertionConsumerServiceBinding)</code></th>
<td class="colLast">
<div class="block">Set the <a href="https://www.oasis-open.org/committees/download.php/51890/SAML%20MD%20simplified%20overview.pdf#2.3%20AttributeConsumingService">
AssertionConsumerService</a> Binding.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#assertionConsumerServiceLocation(java.lang.String)">assertionConsumerServiceLocation</a></span>&#8203;(java.lang.String&nbsp;assertionConsumerServiceLocation)</code></th>
<td class="colLast">
<div class="block">Set the <a href="https://www.oasis-open.org/committees/download.php/51890/SAML%20MD%20simplified%20overview.pdf#2.3%20AttributeConsumingService">
AssertionConsumerService</a> Location.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#assertionConsumerServiceUrlTemplate(java.lang.String)">assertionConsumerServiceUrlTemplate</a></span>&#8203;(java.lang.String&nbsp;assertionConsumerServiceUrlTemplate)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="RelyingPartyRegistration.Builder.html#assertionConsumerServiceLocation"><code>assertionConsumerServiceLocation</code></a> instead.</div>
</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#build()">build</a></span>()</code></th>
<td class="colLast">
<div class="block">Constructs a RelyingPartyRegistration object based on the builder
configurations</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#credentials(java.util.function.Consumer)">credentials</a></span>&#8203;(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../credentials/Saml2X509Credential.html" title="class in org.springframework.security.saml2.credentials">Saml2X509Credential</a>&gt;&gt;&nbsp;credentials)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="RelyingPartyRegistration.Builder.html#signingX509Credentials"><code>signingX509Credentials</code></a> or
<a href="RelyingPartyRegistration.Builder.html#decryptionX509Credentials"><code>decryptionX509Credentials</code></a> instead for relying party keys or
<a href="RelyingPartyRegistration.AssertingPartyDetails.Builder.html#verificationX509Credentials"><code>RelyingPartyRegistration.AssertingPartyDetails.Builder.verificationX509Credentials</code></a> or
<a href="RelyingPartyRegistration.AssertingPartyDetails.Builder.html#encryptionX509Credentials"><code>RelyingPartyRegistration.AssertingPartyDetails.Builder.encryptionX509Credentials</code></a> for asserting
party keys</div>
</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#decryptionX509Credentials(java.util.function.Consumer)">decryptionX509Credentials</a></span>&#8203;(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core">Saml2X509Credential</a>&gt;&gt;&nbsp;credentialsConsumer)</code></th>
<td class="colLast">
<div class="block">Apply this <code>Consumer</code> to the <code>Collection</code> of
<a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core"><code>Saml2X509Credential</code></a>s for the purposes of modifying the
<code>Collection</code></div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#entityId(java.lang.String)">entityId</a></span>&#8203;(java.lang.String&nbsp;entityId)</code></th>
<td class="colLast">
<div class="block">Set the relying party's <a href="https://www.oasis-open.org/committees/download.php/51890/SAML%20MD%20simplified%20overview.pdf#2.9%20EntityDescriptor">EntityID</a>.</div>
</td>
</tr>
<tr id="i8" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#idpWebSsoUrl(java.lang.String)">idpWebSsoUrl</a></span>&#8203;(java.lang.String&nbsp;url)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use
<code>#assertingPartyDetails(Consumer&lt;AssertingPartyDetails.Builder &gt;)</code></div>
</div>
</td>
</tr>
<tr id="i9" class="rowColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#localEntityIdTemplate(java.lang.String)">localEntityIdTemplate</a></span>&#8203;(java.lang.String&nbsp;template)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="RelyingPartyRegistration.Builder.html#entityId"><code>entityId</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i10" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#providerDetails(java.util.function.Consumer)">providerDetails</a></span>&#8203;(java.util.function.Consumer&lt;<a href="RelyingPartyRegistration.ProviderDetails.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.ProviderDetails.Builder</a>&gt;&nbsp;providerDetails)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="RelyingPartyRegistration.Builder.html#assertingPartyDetails(java.util.function.Consumer)"><code>assertingPartyDetails(java.util.function.Consumer&lt;org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.AssertingPartyDetails.Builder&gt;)</code></a> instead</div>
</div>
</td>
</tr>
<tr id="i11" class="rowColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#registrationId(java.lang.String)">registrationId</a></span>&#8203;(java.lang.String&nbsp;id)</code></th>
<td class="colLast">
<div class="block">Sets the <code>registrationId</code> template.</div>
</td>
</tr>
<tr id="i12" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#remoteIdpEntityId(java.lang.String)">remoteIdpEntityId</a></span>&#8203;(java.lang.String&nbsp;entityId)</code></th>
<td class="colLast">
<div class="block"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use
<code>#assertingPartyDetails(Consumer&lt;AssertingPartyDetails.Builder &gt;)</code></div>
</div>
</td>
</tr>
<tr id="i13" class="rowColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#signingX509Credentials(java.util.function.Consumer)">signingX509Credentials</a></span>&#8203;(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core">Saml2X509Credential</a>&gt;&gt;&nbsp;credentialsConsumer)</code></th>
<td class="colLast">
<div class="block">Apply this <code>Consumer</code> to the <code>Collection</code> of
<a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core"><code>Saml2X509Credential</code></a>s for the purposes of modifying the
<code>Collection</code></div>
</td>
</tr>
<tr id="i14" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#singleLogoutServiceBinding(org.springframework.security.saml2.provider.service.registration.Saml2MessageBinding)">singleLogoutServiceBinding</a></span>&#8203;(<a href="Saml2MessageBinding.html" title="enum in org.springframework.security.saml2.provider.service.registration">Saml2MessageBinding</a>&nbsp;singleLogoutServiceBinding)</code></th>
<td class="colLast">
<div class="block">Set the <a href="https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService
Binding</a></div>
</td>
</tr>
<tr id="i15" class="rowColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#singleLogoutServiceLocation(java.lang.String)">singleLogoutServiceLocation</a></span>&#8203;(java.lang.String&nbsp;singleLogoutServiceLocation)</code></th>
<td class="colLast">
<div class="block">Set the <a href="https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService
Location</a></div>
</td>
</tr>
<tr id="i16" class="altColor">
<td class="colFirst"><code><a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a></code></td>
<th class="colSecond" scope="row"><code><span class="memberNameLink"><a href="RelyingPartyRegistration.Builder.html#singleLogoutServiceResponseLocation(java.lang.String)">singleLogoutServiceResponseLocation</a></span>&#8203;(java.lang.String&nbsp;singleLogoutServiceResponseLocation)</code></th>
<td class="colLast">
<div class="block">Set the <a href="https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService
Response Location</a></div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a id="methods.inherited.from.class.java.lang.Object">

</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">

<section role="region">
<ul class="blockList">
<li class="blockList"><a id="method.detail">

</a>
<h3>Method Detail</h3>
<a id="registrationId(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>registrationId</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;registrationId&#8203;(java.lang.String&nbsp;id)</pre>
<div class="block">Sets the <code>registrationId</code> template. Often be used in URL paths</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>id</code> - registrationId for this object, should be unique</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object</dd>
</dl>
</li>
</ul>
<a id="entityId(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>entityId</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;entityId&#8203;(java.lang.String&nbsp;entityId)</pre>
<div class="block">Set the relying party's <a href="https://www.oasis-open.org/committees/download.php/51890/SAML%20MD%20simplified%20overview.pdf#2.9%20EntityDescriptor">EntityID</a>.
Equivalent to the value found in the relying party's &lt;EntityDescriptor
EntityID="..."/&gt;
This value may contain a number of placeholders. They are <code>baseUrl</code>,
<code>registrationId</code>, <code>baseScheme</code>, <code>baseHost</code>, and
<code>basePort</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entityId</code> - the relying party's EntityID</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
</dl>
</li>
</ul>
<a id="signingX509Credentials(java.util.function.Consumer)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>signingX509Credentials</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;signingX509Credentials&#8203;(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core">Saml2X509Credential</a>&gt;&gt;&nbsp;credentialsConsumer)</pre>
<div class="block">Apply this <code>Consumer</code> to the <code>Collection</code> of
<a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core"><code>Saml2X509Credential</code></a>s for the purposes of modifying the
<code>Collection</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>credentialsConsumer</code> - - the <code>Consumer</code> for modifying the
<code>Collection</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
</dl>
</li>
</ul>
<a id="decryptionX509Credentials(java.util.function.Consumer)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>decryptionX509Credentials</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;decryptionX509Credentials&#8203;(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core">Saml2X509Credential</a>&gt;&gt;&nbsp;credentialsConsumer)</pre>
<div class="block">Apply this <code>Consumer</code> to the <code>Collection</code> of
<a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core"><code>Saml2X509Credential</code></a>s for the purposes of modifying the
<code>Collection</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>credentialsConsumer</code> - - the <code>Consumer</code> for modifying the
<code>Collection</code></dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
</dl>
</li>
</ul>
<a id="assertionConsumerServiceLocation(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>assertionConsumerServiceLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;assertionConsumerServiceLocation&#8203;(java.lang.String&nbsp;assertionConsumerServiceLocation)</pre>
<div class="block">Set the <a href="https://www.oasis-open.org/committees/download.php/51890/SAML%20MD%20simplified%20overview.pdf#2.3%20AttributeConsumingService">
AssertionConsumerService</a> Location.
<p>
Equivalent to the value found in &lt;AssertionConsumerService
Location="..."/&gt; in the relying party's &lt;SPSSODescriptor&gt;
<p>
This value may contain a number of placeholders. They are <code>baseUrl</code>,
<code>registrationId</code>, <code>baseScheme</code>, <code>baseHost</code>, and
<code>basePort</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>assertionConsumerServiceLocation</code> - the AssertionConsumerService location</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
</dl>
</li>
</ul>
<a id="assertionConsumerServiceBinding(org.springframework.security.saml2.provider.service.registration.Saml2MessageBinding)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>assertionConsumerServiceBinding</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;assertionConsumerServiceBinding&#8203;(<a href="Saml2MessageBinding.html" title="enum in org.springframework.security.saml2.provider.service.registration">Saml2MessageBinding</a>&nbsp;assertionConsumerServiceBinding)</pre>
<div class="block">Set the <a href="https://www.oasis-open.org/committees/download.php/51890/SAML%20MD%20simplified%20overview.pdf#2.3%20AttributeConsumingService">
AssertionConsumerService</a> Binding.
<p>
Equivalent to the value found in &lt;AssertionConsumerService
Binding="..."/&gt; in the relying party's &lt;SPSSODescriptor&gt;</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>assertionConsumerServiceBinding</code> - the AssertionConsumerService binding</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
</dl>
</li>
</ul>
<a id="singleLogoutServiceBinding(org.springframework.security.saml2.provider.service.registration.Saml2MessageBinding)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>singleLogoutServiceBinding</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;singleLogoutServiceBinding&#8203;(<a href="Saml2MessageBinding.html" title="enum in org.springframework.security.saml2.provider.service.registration">Saml2MessageBinding</a>&nbsp;singleLogoutServiceBinding)</pre>
<div class="block">Set the <a href="https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService
Binding</a>
<p>
Equivalent to the value found in &lt;SingleLogoutService Binding="..."/&gt; in
the relying party's &lt;SPSSODescriptor&gt;.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>singleLogoutServiceBinding</code> - the SingleLogoutService Binding</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.6</dd>
</dl>
</li>
</ul>
<a id="singleLogoutServiceLocation(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>singleLogoutServiceLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;singleLogoutServiceLocation&#8203;(java.lang.String&nbsp;singleLogoutServiceLocation)</pre>
<div class="block">Set the <a href="https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService
Location</a>
<p>
Equivalent to the value found in &lt;SingleLogoutService Location="..."/&gt; in
the relying party's &lt;SPSSODescriptor&gt;.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>singleLogoutServiceLocation</code> - the SingleLogoutService Location</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.6</dd>
</dl>
</li>
</ul>
<a id="singleLogoutServiceResponseLocation(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>singleLogoutServiceResponseLocation</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;singleLogoutServiceResponseLocation&#8203;(java.lang.String&nbsp;singleLogoutServiceResponseLocation)</pre>
<div class="block">Set the <a href="https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf#page=7">SingleLogoutService
Response Location</a>
<p>
Equivalent to the value found in &lt;SingleLogoutService
ResponseLocation="..."/&gt; in the relying party's &lt;SPSSODescriptor&gt;.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>singleLogoutServiceResponseLocation</code> - the SingleLogoutService Response
Location</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.6</dd>
</dl>
</li>
</ul>
<a id="assertingPartyDetails(java.util.function.Consumer)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>assertingPartyDetails</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;assertingPartyDetails&#8203;(java.util.function.Consumer&lt;<a href="RelyingPartyRegistration.AssertingPartyDetails.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.AssertingPartyDetails.Builder</a>&gt;&nbsp;assertingPartyDetails)</pre>
<div class="block">Apply this <code>Consumer</code> to further configure the Asserting Party details</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>assertingPartyDetails</code> - The <code>Consumer</code> to apply</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the <a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration"><code>RelyingPartyRegistration.Builder</code></a> for further configuration</dd>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>5.4</dd>
</dl>
</li>
</ul>
<a id="credentials(java.util.function.Consumer)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>credentials</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;credentials&#8203;(java.util.function.Consumer&lt;java.util.Collection&lt;<a href="../../../credentials/Saml2X509Credential.html" title="class in org.springframework.security.saml2.credentials">Saml2X509Credential</a>&gt;&gt;&nbsp;credentials)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="RelyingPartyRegistration.Builder.html#signingX509Credentials"><code>signingX509Credentials</code></a> or
<a href="RelyingPartyRegistration.Builder.html#decryptionX509Credentials"><code>decryptionX509Credentials</code></a> instead for relying party keys or
<a href="RelyingPartyRegistration.AssertingPartyDetails.Builder.html#verificationX509Credentials"><code>RelyingPartyRegistration.AssertingPartyDetails.Builder.verificationX509Credentials</code></a> or
<a href="RelyingPartyRegistration.AssertingPartyDetails.Builder.html#encryptionX509Credentials"><code>RelyingPartyRegistration.AssertingPartyDetails.Builder.encryptionX509Credentials</code></a> for asserting
party keys</div>
</div>
<div class="block">Modifies the collection of <a href="../../../core/Saml2X509Credential.html" title="class in org.springframework.security.saml2.core"><code>Saml2X509Credential</code></a> objects used in
communication between IDP and SP For example: <code>
Saml2X509Credential credential = ...;
return RelyingPartyRegistration.withRegistrationId("id")
.credentials((c) -&gt; c.add(credential))
...
.build();
</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>credentials</code> - - a consumer that can modify the collection of credentials</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object</dd>
</dl>
</li>
</ul>
<a id="assertionConsumerServiceUrlTemplate(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>assertionConsumerServiceUrlTemplate</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;assertionConsumerServiceUrlTemplate&#8203;(java.lang.String&nbsp;assertionConsumerServiceUrlTemplate)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="RelyingPartyRegistration.Builder.html#assertionConsumerServiceLocation"><code>assertionConsumerServiceLocation</code></a> instead.</div>
</div>
<div class="block"><a href="https://www.oasis-open.org/committees/download.php/51890/SAML%20MD%20simplified%20overview.pdf#2.3%20AttributeConsumingService">Assertion
Consumer Service</a> URL template. It can contain variables <code>baseUrl</code>,
<code>registrationId</code>, <code>baseScheme</code>, <code>baseHost</code>, and
<code>basePort</code>.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>assertionConsumerServiceUrlTemplate</code> - the Assertion Consumer Service URL
template (i.e. "{baseUrl}/login/saml2/sso/{registrationId}".</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object</dd>
</dl>
</li>
</ul>
<a id="remoteIdpEntityId(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>remoteIdpEntityId</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;remoteIdpEntityId&#8203;(java.lang.String&nbsp;entityId)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use
<code>#assertingPartyDetails(Consumer&lt;AssertingPartyDetails.Builder &gt;)</code></div>
</div>
<div class="block">Sets the <code>entityId</code> for the remote asserting party, the Identity
Provider.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>entityId</code> - the IDP entityId</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object</dd>
</dl>
</li>
</ul>
<a id="idpWebSsoUrl(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>idpWebSsoUrl</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;idpWebSsoUrl&#8203;(java.lang.String&nbsp;url)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">use
<code>#assertingPartyDetails(Consumer&lt;AssertingPartyDetails.Builder &gt;)</code></div>
</div>
<div class="block">Sets the <code>SSO URL</code> for the remote asserting party, the Identity Provider.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>url</code> - - a URL that accepts authentication requests via REDIRECT or POST
bindings</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object</dd>
</dl>
</li>
</ul>
<a id="localEntityIdTemplate(java.lang.String)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>localEntityIdTemplate</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;localEntityIdTemplate&#8203;(java.lang.String&nbsp;template)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="RelyingPartyRegistration.Builder.html#entityId"><code>entityId</code></a> instead</div>
</div>
<div class="block">Sets the local relying party, or Service Provider, entity Id template. can
generate it's entity ID based on possible variables of <code>baseUrl</code>,
<code>registrationId</code>, <code>baseScheme</code>, <code>baseHost</code>, and
<code>basePort</code>, for example
<code>{baseUrl}/saml2/service-provider-metadata/{registrationId}</code></div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>template</code> - the entity id</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a string containing the entity ID or entity ID template</dd>
</dl>
</li>
</ul>
<a id="providerDetails(java.util.function.Consumer)">

</a>
<ul class="blockList">
<li class="blockList">
<h4>providerDetails</h4>
<pre class="methodSignature">@Deprecated
public&nbsp;<a href="RelyingPartyRegistration.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.Builder</a>&nbsp;providerDetails&#8203;(java.util.function.Consumer&lt;<a href="RelyingPartyRegistration.ProviderDetails.Builder.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration.ProviderDetails.Builder</a>&gt;&nbsp;providerDetails)</pre>
<div class="deprecationBlock"><span class="deprecatedLabel">Deprecated.</span>
<div class="deprecationComment">Use <a href="RelyingPartyRegistration.Builder.html#assertingPartyDetails(java.util.function.Consumer)"><code>assertingPartyDetails(java.util.function.Consumer&lt;org.springframework.security.saml2.provider.service.registration.RelyingPartyRegistration.AssertingPartyDetails.Builder&gt;)</code></a> instead</div>
</div>
<div class="block">Configures the IDP SSO endpoint</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>providerDetails</code> - a consumer that configures the IDP SSO endpoint</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>this object</dd>
</dl>
</li>
</ul>
<a id="build()">

</a>
<ul class="blockListLast">
<li class="blockList">
<h4>build</h4>
<pre class="methodSignature">public&nbsp;<a href="RelyingPartyRegistration.html" title="class in org.springframework.security.saml2.provider.service.registration">RelyingPartyRegistration</a>&nbsp;build()</pre>
<div class="block">Constructs a RelyingPartyRegistration object based on the builder
configurations</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a RelyingPartyRegistration instance</dd>
</dl>
</li>
</ul>
</li>
</ul>
</section>
</li>
</ul>
</div>
</div>
</main>

<footer role="contentinfo">
<nav role="navigation">

<div class="bottomNav"><a id="navbar.bottom">

</a>
<div class="skipNav"><a href="RelyingPartyRegistration.Builder.html#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a id="navbar.bottom.firstrow">

</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../../index.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../../allclasses.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="RelyingPartyRegistration.Builder.html#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="RelyingPartyRegistration.Builder.html#method.detail">Method</a></li>
</ul>
</div>
<a id="skip.navbar.bottom">

</a></div>

</nav>
</footer>
<script>if (window.parent == window) {(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)})(window,document,'script','//www.google-analytics.com/analytics.js','ga');ga('create', 'UA-2728886-23', 'auto', {'siteSpeedSampleRate': 100});ga('send', 'pageview');}</script><script defer src="https://static.cloudflareinsights.com/beacon.min.js/v652eace1692a40cfa3763df669d7439c1639079717194" integrity="sha512-Gi7xpJR8tSkrpF7aordPZQlW2DLtzUlZcumS8dMQjwDHEnw9I7ZLyiOj/6tZStRBGtGgN6ceN6cMH8z7etPGlw==" data-cf-beacon='{"rayId":"7040ea05aa5c97cf","token":"bffcb8a918ae4755926f76178bfbd26b","version":"2021.12.0","si":100}' crossorigin="anonymous"></script>
</body>
</html>
